---

Inside Macintosh: More Macintosh Toolbox

Previous | Chapter Top | Chapter Contents | Next |

GetComponentInfo

The GetComponentInfo function returns all of the registration information for a component. Your application specifies the component with a component identifier returned by the FindNextComponent function. The GetComponentInfo function returns information about the component in a component description record. The GetComponentInfo function also returns the component's name, information string, and icon. (To get a handle to the component's icon suite, if it provides one, use the GetComponentIconSuite function.)

A component provides this registration information when it is registered with the Component Manager.

FUNCTION GetComponentInfo (aComponent: Component;
                                         VAR cd: ComponentDescription;
                                         componentName: Handle;
                                         componentInfo: Handle;
                                         componentIcon: Handle): OSErr;


aComponent

A component identifier that specifies the component for the operation. Your application obtains a component identifier from the FindNextComponent function. If your application registers a component, it can also obtain a component identifier from the RegisterComponent or RegisterComponentResource function.

You may supply a component instance rather than a component identifier to this function. (If you do so, you must coerce the data type appropriately.) Your application can obtain a component instance from the OpenComponent function or the OpenDefaultComponent function.

cd

A component description record. The GetComponentInfo function returns information about the specified component in a component description record.

componentName

An existing handle that is to receive the component's name. If the component does not have a name, the GetComponentInfo function returns an empty handle. Set this field to NIL if you do not want to receive the component's name.

componentInfo

An existing handle that is to receive the component's information string. If the component does not have an information string, the GetComponentInfo function returns an empty handle. Set this field to NIL if you do not want to receive the component's information string.

componentIcon

An existing handle that is to receive the component's icon. If the component does not have an icon, the GetComponentInfo function returns an empty handle. Set this field to NIL if you do not want to receive the component's icon.

GetComponentIconSuite

The GetComponentIconSuite function returns a handle to the component's icon suite (if it provides one).

FUNCTION GetComponentIconSuite (aComponent: Component;
                                          VAR iconSuite: Handle): OSErr;


aComponent

A component identifier that specifies the component for the operation. Your application obtains a component identifier from the FindNextComponent function. If your application registers a component, it can also obtain a component identifier from the RegisterComponent or RegisterComponentResource function.

iconSuite

GetComponentIconSuite returns, in this parameter, a handle to the component's icon suite, if any. If the component has not provided an icon suite, GetComponentIconSuite returns NIL in this parameter.

GetComponentVersion

The GetComponentVersion function returns a component's version number.

FUNCTION GetComponentVersion (ci: ComponentInstance): LongInt;


ci

The component instance from which you want to retrieve version information. Your application obtains the component instance from the OpenDefaultComponent or OpenComponent function.

ComponentFunctionImplemented

The ComponentFunctionImplemented function allows you to determine whether a component supports a specified request. Your application can use this function to determine a component's capabilities.

FUNCTION ComponentFunctionImplemented (ci: ComponentInstance;
                                          ftnNumber: Integer)
                                         : LongInt;


ci

A component instance that specifies the connection for this operation. Your application obtains the component instance from the OpenDefaultComponent or OpenComponent function.

ftnNumber

A request code value. See Inside Macintosh: QuickTime Components for information about the request codes supported by the components supplied by Apple with QuickTime. For other components, see the documentation supplied with the component for request code values.